home *** CD-ROM | disk | FTP | other *** search
/ Just Call Me Internet / Just Call Me Internet.iso / com / othernet / fidonet / ffind108 / filefind.doc next >
Text File  |  1993-10-17  |  15KB  |  325 lines
  1.                           -*- File-Finder v1.08 -*-
  2.  
  3.                          Copyright (c) 1993 M.J.Matts
  4.  
  5.     An easy to use network utility to enable users to search for the 
  6.     existance and location of files simply by sending out a networked 
  7.     message. It offers support for many vaired formats of file description 
  8.     data files used by many BBS packages.
  9.  
  10.     To use File-Finder you must create (or edit the example) a config 
  11.     file named FILEFIND.CFG which must reside in the same folder as the 
  12.     main FILEFIND.PRG file. This config file will enable File-Finder to 
  13.     know where to search for files, what information about your system 
  14.     will be placed into replies to enable a user to easily access your 
  15.     system along with other things such as paths etc.. The following are 
  16.     all the commands available for use within the config file.
  17.  
  18. Command: SYSOP <your name>
  19. Example: sysop Mark Matts
  20. Purpose: Used for information in replies.
  21.  
  22. Command: SYSTEM <your BBS or mail system's name>
  23. Example: system System ST
  24. Purpose: Used for information in replies.
  25.  
  26. Command: LOCATION <your location>
  27. Example: location Leicester, UK
  28. Purpose: Used for information in replies.
  29.  
  30. Command: PHONE <your telephonr number>
  31. Example: phone +44 (0)533 413443
  32. Purpose: Used for information in replies.
  33.  
  34. Command: BAUD <your systems baud rate>
  35. Example: baud 1200/2400/9600
  36. Purpose: Used for information in replies.
  37.  
  38. Command: TIMES <your online times>
  39. Example: times 10pm to 7am
  40. Purpose: Used for information in replies.
  41.  
  42. Command: ADDRESS <network address>
  43. Example: address 90:100/101.0
  44. Purpose: Used for information in replies. You can define upto 10 
  45.          different addresses.
  46.  
  47. Command: MSGBASE <path & filename (no extender) to File-Finder msg base>
  48. Example: MsgBase f:\nestware\filefind\msgbase\n_allfix
  49. Purpose: Tells File-Finder which message base to scan for File-Finder 
  50.          messages and also where to reply to them. **NOTE** Please make 
  51.          sure this message base has been setup specifically to operate as 
  52.          a file finder system. On the NeST network the base used for this 
  53.          purpose is called N_ALLFIX and should be available from most 
  54.          mailer systems. By defining multiple message bases (upto 10) you 
  55.          can run File-Finder on different networks.. See config file for 
  56.          example of multiple msgbase commands.
  57.  
  58. Command: FINDERNAME <name of TO: field to respond to>
  59. Example: findername allfix
  60. Purpose: Tells File-Finder what to check for and react to when scanning 
  61.          for request messages. You can define upto 10 different 
  62.          File-Finder names. Please note that this command is *NOT* case 
  63.          sensitive so ALLFIX is treated the same as allfix. ALLFIX and 
  64.          FILEFINDER are default settings so this command is only needed 
  65.          when other finder names are to be used.
  66.  
  67. Command: LOGFILE <path & filename to log File to use>
  68. Example: logfile f:\binkley\binkley.log
  69. Purpose: Tells File-Finder which file to use for logging it's activity. A 
  70.          BinkleyTerm format is used with FFDR as the text identifier. Log 
  71.          entries will only be made if File-Finder actually does anything.
  72.  
  73. Command: MAXDESC <maximum number of description to allow in a reply>
  74. Example: maxdesc 10
  75. Purpose: Forces File-Finder not to include any more than the given 
  76.          number of descriptions in a reply message. This should hopefully 
  77.          avoid any excessively large messages being sent into the 
  78.          networks. The maximum setting is 15 which is also the default so 
  79.          this option is only of use if you wish to cut down the limit 
  80.          since you cannot increase it above 15. This limit also applies to 
  81.          replies sent to a description request..
  82.  
  83. Command: LOCK <filename>
  84. Example: lock private.lzh
  85. Purpose: Allows you to lock a named file from being included in a 
  86.          File-Finder reply. You can define upto 100 locked files.
  87.  
  88. Command: FROMSYSOP
  89. Example: fromsysop
  90. Purpose: All replies sent out from your system will be addressed from your
  91.          sysop name as defined by the SYSOP command instead of the default 
  92.          File-Finder.
  93.  
  94. Command: FROMSYSTEM
  95. Example: fromsystem
  96. Purpose: All replies sent out from your system will be addressed from your
  97.          system name as defined by the SYSTEM command instead of the 
  98.          default File-Finder.
  99.  
  100. Command: SCANALL
  101. Example: scanall
  102. Purpose: Forces File-Finder to scan the entire message base each time it 
  103.          is run rather then from the last read message.
  104.  
  105.  
  106.         -**- The following commands each make File-Finder look for -**-
  107.         -**- different description files which are used by the     -**-
  108.         -**- relevant BBS package named. You may mix the BBS name  -**-
  109.         -**- commands if your system uses more than just one type. -**-
  110.         -**- Depending on the type of BBs named the format of the  -**-
  111.         -**- ACCESS command will be slightly different so please   -**-
  112.         -**- take the time to read which format your setup uses.   -**-
  113.  
  114.                                     ~~##~~
  115.  
  116. Command: QUICKBBS
  117. Example: quickbbs
  118. Purpose: This keyword will make File-Finder search a FILES.BBS file (in 
  119.          QuickBBS format)in the path defined by the first parameter of the 
  120.          relevant ACCESS commands.
  121.  
  122.                      -= Associated Commands & Formats =-
  123.  
  124. Command: ACCESS <path to file area> <[Area description]>
  125. Example: access I:\COMMS\ [Communications Software]
  126.  
  127.                                     ~~##~~
  128.  
  129. Command: TURBO <path to *.FIL files>
  130. Example: turbo h:\turbo\data\
  131. Purpose: This keyword will make File-Finder search the given path 
  132.          for any FIL files named for each area. (TurboBoard v2 format)
  133.  
  134.                     -= Associated Commands & Formats =-
  135.  
  136. Command: ACCESS <path to file area> <[Area description]> <{FIL name}>
  137. Example: access I:\COMMS\ [Communications Software] {comms}
  138.  
  139.                                     ~~##~~
  140.  
  141. Command: FOREM
  142. Example: Forem
  143. Purpose: This keyword will make File-Finder search in the path given in 
  144.          each access command for the named DIR file for each area.
  145.  
  146.                      -= Associated Commands & Formats =-
  147.  
  148. Command: ACCESS <path to file area> <[Area description]> <{DIR name}>
  149. Example: access I:\COMMS\ [Communications Software] {comms}
  150.  
  151.                                     ~~##~~
  152.  
  153. Command: STKEEP
  154. Example: stkeep
  155. Purpose: This keyword will make File-Finder search in the FILES folder 
  156.          which should be in the path defined by the first parameter of the 
  157.          relevant ACCESS commands.
  158.  
  159.                      -= Associated Commands & Formats =-
  160.  
  161. Command: ACCESS <path to file area> <[Area description]>
  162. Example: access I:\COMMS\ [Communications Software]
  163.  
  164.                                     ~~##~~
  165.  
  166. Command: EXPRESS
  167. Example: express
  168. Purpose: This keyword will make File-Finder search in the DESC folder which 
  169.          should be in the path defined by the first parameter of the 
  170.          relevant ACCESS commands.
  171.  
  172.                      -= Associated Commands & Formats =-
  173.  
  174. Command: ACCESS <path to file area> <[Area description]>
  175. Example: access I:\COMMS\ [Communications Software]
  176.  
  177.                                     ~~##~~
  178.  
  179. Command: WIZFILE <path & filename of WIZfile description file>
  180. Example: wizfile h:\wizfile\allfile.txt
  181. Purpose: This keyword will make File-Finder search the file list 
  182.          created by WIZfile, however, the file must be in the format 
  183.          produced by pre WIZfile v1.30.
  184.  
  185.                      -= Associated Commands & Formats =-
  186.  
  187. Command: ACCESS <path to file area> <[Area description]>
  188. Example: access I:\COMMS\ [Communications  Software]
  189.  
  190.                                     ~~##~~
  191.  
  192. Command: NEWWIZFILE <path & filename of WIZfile description file>
  193. Example: newwizfile h:\wizfile\files.bbs
  194. Purpose: This keyword will make File-Finder search the new format of file 
  195.          list created by WIZfile v1.03 using the -F option.
  196.  
  197.                      -= Associated Commands & Formats =-
  198.  
  199. Command: ACCESS <path to file area> <[Area description]>
  200. Example: access I:\COMMS\ [Communications  Software]
  201.  
  202.                                     ~~##~~
  203.  
  204. Command: RATSOFT <path to main RATSoftoft folder (config.dat)>
  205. Example: ratsoft h:\ratsoft\
  206. Purpose: Using this command you will NOt need to define any ACCESS 
  207.          commands, all the ACCESS paths and area descriptions will be 
  208.          taken directly from the RATSoft environment which is found by 
  209.          using the path after this command.
  210.  
  211.                      -= Associated Commands & Formats =-
  212.  
  213. Command: RATLEVEL <maximum file/area level to scan>
  214. Example: ratlevel 200
  215. Purpose: Limits the files/areas to be scanned according to the access 
  216.          level set. Default is 254 (ie 255 sysops only areas will be 
  217.          ignored)
  218.                                     ~~##~~
  219.  
  220.                                    ---**---
  221.  
  222.         PLEASE NOTE THAT THE USE OF ANY OF THE BBS NAME COMMANDS WILL
  223.         ONLY BE NEEDED IF DESCRIPTIONS ARE TO BE INCLUDED IN A REPLY 
  224.         MESSAGE OR THE DESCRIPTION SEARCH FEATURE IS TO BE USED. 
  225.         FILE-FINDER GETS THE FILENAME, SIZE AND DATE BY SCANNING THE ACTUAL 
  226.         FOLDER GIVEN IN EACH ACCESS COMMAND WHICH MEANS YOU DO NOT HAVE TO 
  227.         BE RUNNING ANY SPECIFIC BBS PACKAGE TO BE ABLE TO USE THE PROGRAM. 
  228.         THE ONLY THING LOST BY RUNNING AN UNSUPPORTED BBS WILL BE THE LACK 
  229.         OF FILE DESCRIPTIONS. IF YOU WOULD LIKE TO HAVE YOUR BBS PACKAGE 
  230.         SUPPORTED PLEASE SEND ME THE STRUCTURES & AN EXAMPLE OF ANY FILE(S) 
  231.         WHICH HOLD THE FILE DESCRIPTIONS PLUS OTHER INFO WHICH WILL HELP ME.
  232.  
  233.                                    ---**---
  234.  
  235. Command: ACCESS (followed by parameters relevant to your BBS package)
  236. Example: access I:\COMMS\ [Communications Software] {comms}
  237. Purpose: The first parameter will tell File-Finder which path to search 
  238.          for files which match the requested filename. You can define upto 
  239.          300 different paths. The parameters enclosed in the square & curly 
  240.          brackets are optional and is only used for information purposes 
  241.          and may differ depending on the BBS setting used. If a file is 
  242.          found in the path given it will be listed as being in the area 
  243.          defined within the square brackets. Please refer to the above BBS 
  244.          commands which will be suitable for you.
  245.  
  246.  
  247.     Thats all there is to it.. You can specify both any of the BBS name 
  248.     commands if your system uses a mixture of both formats, ideal for 
  249.     multiBBS systems. A check will be made for both file formats in each 
  250.     area and the description will be taken from the first one found.
  251.  
  252.     If File-Finder writes a reply to any File-Find enquiries it will exit 
  253.     with an errorlevel of 1 therefore allowing you to run your exporter 
  254.     if needed. An errorlevel of 0 is used in all other instances.
  255.  
  256.  
  257.                        ** How to use File-Finder **
  258.  
  259.     To use the File-Finder system is very easy, basically all you do is 
  260.     address a message in the relevant File-Finder message base to the 
  261.     usual file search facility name, usually ALLFIX or FILEFINDER. Then on 
  262.     the subject line you simply put the name of the file or description to 
  263.     be searched for. Wildcards in filenames are allowed but to prevent 
  264.     abuse of the system a strict wildcard minimum has been implemented, 
  265.     this means that ? is NOT allowed as a wildcard at all, if a question 
  266.     mark is found it will simply be removed from the file name, therefore 
  267.     GEM?.PRG will be truncated to GEM.PRG.. You may use *.* but it *MUST* 
  268.     be preceeded by at least 3 valid characters. For example to search for 
  269.     STZIP.PRG you could use STZ*.*, STZIP.* etc.. To search for a file by 
  270.     description you must put {desc:?????} on the subject line. A minimum 
  271.     of 5 characters can be used which do NOT include spaces.  If you DO NOT 
  272.     want to have any descriptions sent back in a message include {NODESC} 
  273.     after the filename... All commands can be mixed on the subject line so 
  274.     a description search and filename search can be performed by the same 
  275.     request message, however, the replies will be sent back in two seperate 
  276.     messages, one for the filename search and one for the description 
  277.     search. For example..
  278.  
  279.         From: Mark Matts
  280.           To: File-finder
  281.         Subj: GFA*.* {nodesc} {desc:source}
  282.  
  283.     This will return a message containing any filenames starting with GFA 
  284.     without any descriptions included and also another reply list of any 
  285.     files which have the word 'SOURCE' in their description, however the 
  286.     descriptions again will NOT be included due to the use of the {nodesc} 
  287.     command.
  288.  
  289.         ------
  290.  
  291.     Valid 'subj:' line commands..
  292.  
  293.     GFA*.*   - File mask to be searched for (No '?'s to be used). The 
  294.                example given is the minimum wildcard mask allowed, ie a 
  295.                minimum of 3 characters must be present. Full filenames are 
  296.                also acceptable.
  297.     {nodesc} - Requests that no descriptions be included in the answer.
  298.     {desc:?} - Description mask to be searched for, minimum of 5 chars.
  299.     {adr:?}  - Replies will be sent only from systems matching the specific 
  300.                network address mask given here. This field is also used in 
  301.                conjunction with the {list:?} command.
  302.     {loc:?}  - Replies will be sent only from systems matching the specific 
  303.                location mask given here.
  304.     {list:?} - A verbose archive listing for the defined file will be 
  305.                produced ONLY from the system named using the {adr:?} 
  306.                command. If no {adr:?} is given the request will be ignored 
  307.                by all systems. Wildcards are NOT allowed either, you may 
  308.                only request a verbose listing for a full filename. the 
  309.                ARJ, ARC, ZOO, ZIP & LZH archive formats are supported.
  310.  
  311.         ------
  312.  
  313.     If you have any problems (or ideas) please contact me via the 
  314.     following addresses:
  315.  
  316.                Mark Matts @ NeST 90:100/101.0
  317.                             FidoNet 2:255/320.0
  318.                             AtariNet 51:6/4.0
  319.  
  320.     Alternativly if you are connected to the NeST network why not join 
  321.     the NESTWARE echo where myself and many other NeSTware programmers 
  322.     can easily be contacted with bug reports, requests etc..
  323.  
  324.  
  325.